home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d2 / udesc123.arc / UDESC123.DOC < prev   
Text File  |  1990-08-04  |  17KB  |  503 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.                        Update File Descriptions
  8.  
  9.                                  "UD"
  10.  
  11.                           by Earl R. Davidson
  12.  
  13.                      Version 1.23, August 5, 1990
  14.  
  15.  
  16. Program and Documentation Copyright (c) 1990, by Earl R. Davidson.  All
  17. rights reserved.
  18.  
  19.  
  20. Portions Copyright (c) 1989, Microsoft Corporation
  21. Portions Copyright (c) 1988 and 1989, Ethan Winer, Donald R. Malin and
  22. Crescent Software
  23.  
  24.  
  25. 4DOS is a trademark of J. P. Software.
  26. PC-DOS is a trademark of IBM Corporation.
  27. MS-DOS is a trademark of Microsoft Corporation.
  28.  
  29.  
  30. This program is not in the public domain!  You are hereby granted a
  31. limited right to copy the program and pass it on to friends and upload
  32. it to any bulletin board system, provided no fee is charged other than
  33. a nominal disk fee.  You may use the program for up to twenty one (21)
  34. days.  If you use it for more than this, please register.
  35.  
  36.  
  37.                            Acknowledgments
  38.                       
  39. This program was written using Microsoft Basic 7.0 Professional
  40. Development System and the Crescent Software QuickPak Professional
  41. Advanced Programming Library (Version 3.10).  4DOS (Version 3.01A) by 
  42. J. P. Software, was also being used; and, in fact, provided the
  43. inspiration for this program.  I thank all three companies for
  44. making these outstanding products available.
  45.  
  46.  
  47.                              Disclaimer
  48.  
  49. UD is distributed without warranty, expressed or implied, including 
  50. without limitation the warranties of merchantability and of fitness
  51. for a particular purpose.  The user is cautioned that improper use of
  52. UD may result in lost or damaged files or may cause other damage to 
  53. your computer software and data.  The user assumes full responsibility
  54. for the selection and use of UD to acheive your desired results.
  55.  
  56.  
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.  
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.  
  71.                              Introduction
  72.                        
  73. 4DOS provides the capability to add file descriptions to your files
  74. and display these descriptions when you display a file directory.  I
  75. have found this to be a very handy way to keep up with various
  76. versions of programs and files.  Also, when I download files from
  77. BBS's, I note the date and BBS in the description.  Since it's not
  78. always easy to remember every file created or downloaded in a day's
  79. time, I wrote this program to help me.  I hope you find it helpful.
  80.  
  81. This program provides an easy way to update the 4DOS file descriptions
  82. of your files.  You may select files based on the file date or on the
  83. archive bit.  An option allows your selection to exclude files based
  84. on their filename extension.  You may, optionally, exclude files that
  85. have already been described and/or you may use a 'listfile' to exclude
  86. any individual filenames of your choice.  Once the selection is made
  87. the 4DOS DESCRIBE command is called for each file.  Multiple
  88. directories may be searched simultaneously.
  89.  
  90.  
  91.                                Using UD
  92.                              
  93. If you run UD without any command line parameters the program will
  94. perform using the defaults.  UD begins by creating a temporary batch
  95. file, whose default name is UPDTDESC.BTM, and writing a line with the
  96. "@ECHO OFF" command to it.  UD then begins in the current drive and
  97. directory, examining the file date of each file.  If the file date is
  98. equal to (or greater than?) the system date, then the command DESCRIBE
  99. and the file's complete path and filename is added to a line in
  100. UPDTDESC.BTM.  UD searches any sub-directories below the current
  101. directory. 
  102.  
  103. A few files are automatically omitted from the selection: 
  104. UPDTDESC.BTM, UPDTDESC.LST, DESCRIPT.ION, and all 4DOSSWAP files. 
  105. Once all appropriate files have been examined, UD runs the UPDTDESC.BTM
  106. file, which simply calls the 4DOS DESCRIBE command for each file.  Once
  107. UPDTDESC.BTM is finished, it is deleted.  
  108.  
  109. If UD is run just prior to turning your computer off for the day, you
  110. will be given the opportunity to add descriptions for each file added
  111. or modified that day.
  112.  
  113.  
  114.                      Alternate beginning directory
  115.  
  116. You may have UD begin its search at a directory other than the current
  117. directory by entering a valid drive and/or path as the first parameter
  118. on the command line.  Note that this MUST be the FIRST parameter on
  119. the command line.  UD will search all subdirectories under the
  120. beginning directory.
  121.  
  122.  
  123.      Format:   UD d:\[directory][\subdirectory]
  124.      Default:  the current drive and directory
  125.      Examples: c:\doc\
  126.                a:\
  127.                c:\dos
  128.  
  129.  
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.  
  137.                                 Options
  138.  
  139. Several options are available in UD.  All are entered as command line
  140. parameters.  Options may be entered in any order.  Options must be
  141. separated by either a space or a comma.  The number of options is 
  142. limited only by the length of the dos command line.
  143.  
  144. -----------------------------------------------------------------------
  145.  
  146. USE ARCHIVE BIT FOR FILE SELECTION:
  147.  
  148.    Format:   /A
  149.    Default:   by default, the file date is examined
  150.    Example:  /A
  151.  
  152. This option causes UD to select only those files whose archive bit is
  153. set on.  The file date - and /D option - are ignored.  Other selection
  154. criteria are still considered.  This allows you to include files which
  155. have been extracted from various archive (PAK, ZIP, ARC, etc.) with
  156. their original file dates, which are probably before the current date. 
  157. Using the /D option is often not appropriate when files are added this
  158. way.  
  159.  
  160. -----------------------------------------------------------------------
  161.  
  162. USE ARCHIVE BIT FOR FILE SELECTION AND TURN ARCHIVE BIT OFF:
  163.  
  164.    Format:   /B
  165.    Default:  by default, the date is examined
  166.    Example:  /B
  167.  
  168. This is the same as the /A option above except the archive bit is
  169. turned off as the descriptions are entered/edited.  This will prevent
  170. the file from being selected when UD is run again with the /A or /B
  171. options.
  172.  
  173.    ***************************************************************     
  174.    * - WARNING - USE OF THE /B OPTION MAY CAUSE PROBLEMS FOR     *
  175.    * PEOPLE WHO USE THE DOS BACKUP, RESTORE, AND XCOPY COMMANDS. *
  176.    *                 USE IT WITH CAUTION!                        *
  177.    ***************************************************************
  178.  
  179. -----------------------------------------------------------------------
  180.  
  181. OPTIONAL STARTING DATE:
  182.  
  183.      Format:   /D<mmddyy>
  184.      Default:  the current system date
  185.      Examples: /D062390
  186.  
  187. Using an optional starting date causes only files dated on or after
  188. that date to be included by UD.
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.  
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.  
  203. -----------------------------------------------------------------------
  204.  
  205. ALTERNATE OUTPUT FILENAME:
  206.  
  207.    Format:   /F<filename.ext>
  208.    Default:  UPDTDESC.BTM  (a 4DOS Batch To Memory file)
  209.    Examples: /Fupdtdesc.bat
  210.              /Ftemp.bat
  211.              /Ftemp.btm
  212.  
  213. UD creates a text file consisting of 4DOS commands.  Once UD has
  214. searched all directories, it runs this batch file.  If you use the /F
  215. parameter, you should follow it with a valid dos filename and
  216. extension that will be executable.  It should end with .BAT or .BTM. 
  217. This file is automatically deleted once it is finished.
  218.  
  219. ---------------------------------------------------------------------- 
  220.  
  221. DELETE FILES WHOSE DESCRIPTION IS "KILL"
  222.    
  223.    Format:   /K
  224.  
  225. As you edit your file descriptions, you may find one or more files 
  226. that you need to delete.  If you enter the word "KILL" or "kill" as
  227. the file description, you may later run UD with the /K option and it
  228. will delete the file(s) for you.  This option uses the 4DOS /P option
  229. for the DEL command, which prompts you to enter Y to confirm that you
  230. want the file deleted.  Most other options are invalid when you use
  231. /K.  You may, however, enter a starting path and or option /O.
  232.  
  233. If you begin the file description with the word "TRASH" or "trash", 
  234. running UD with option /K will move the file to a sub-directory named
  235. "\TRASH" on the current drive or alternate drive if one was specified.
  236. If the \TRASH directory does not exist, one will be created.  You may
  237. then hold the files in the \TRASH directory until you decide to delete
  238. them or move them somewhere else.
  239.  
  240. Note that this option will delete a file only if the description is
  241. "KILL".  This prevents a file from being deleted accidently if the
  242. description is something like "KILLER SHARK - GIF FILE".  However,
  243. since moving a file to the \TRASH directory does not delete it and
  244. you may want some description to remain with the file, the file will
  245. be moved if the description begins with "TRASH".  A description of
  246. "TRASH - OLD VERSION" will cause the file to be moved when the /K
  247. option is used.
  248.  
  249. Files with a description of "TRASH" that are already located in a path
  250. that contains the word "TRASH" will not be moved to "\TRASH".
  251.  
  252. ----------------------------------------------------------------------
  253.  
  254. DELETE FILES WHOSE DESCRIPTION IS "KILL" - WITHOUT CONFIRMATION
  255.  
  256.    Format:   /KNOCONFIRM
  257.   
  258. This is the same as the /K option, but the 4DOS /P option is not 
  259. passed to the DEL command.  The files are deleted without confirmation
  260. when the UPDTDESC.BTM file is run.
  261.         
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.  
  269. ----------------------------------------------------------------------
  270.  
  271. USE A LISTFILE TO EXCLUDE SPECIFIC FILES
  272.  
  273.    Format:   /L<listfile.ext>
  274.    Default:  if /L is enteres without an argument, UPDTDESC.LST is used.
  275.    Examples: /L
  276.              /Lskipdesc.txt
  277.  
  278. You should create this ASCII text file with the text editor of your
  279. choice.  It should consist of nothing more than filenames.  Use only
  280. one filename per line.  Do not use any blank lines or remarks.  This
  281. file must be in the same directory in which UD.EXE resides.  Do not try
  282. to pass a path with the filename.ext argument to option /L.  By
  283. default, UD looks for the UPDTDESC.LST file.  If UPDTDESC.LST exists
  284. and you wish to run UD without the listfile being considered, you must 
  285. either delete the file, rename it, or move it to a directory other than
  286. the one UD.EXE resides in.
  287.  
  288. -----------------------------------------------------------------------  
  289.  
  290. MONOCHROME 
  291.  
  292.    Format:   /M
  293.  
  294. This option removes the color from the display as UD runs.  Use this
  295. option if UD does not detect a monochrome monitor, or if you don't 
  296. like my choice of screen colors.
  297.  
  298. -----------------------------------------------------------------------
  299.  
  300. EXCLUDE FILES WITH A GIVEN EXTENSION:
  301.  
  302.    Format:   /NO<ext>
  303.    Default:  none,  all files except those noted above are considered
  304.    Examples: /NObat
  305.              /NObak
  306.              /NOobj /NOlib /NObak
  307.  
  308. This option may be used more than once on the command line to exclude
  309. multiple extensions.
  310.  
  311. -----------------------------------------------------------------------
  312.  
  313. PROCESS ONLY THE CURRENT OR SPECIFIED DIRECTORY - NO SUBDIRECTORIES:
  314.  
  315.    Format:   /O
  316.    Default:  none
  317.    Example:  /O
  318.  
  319. Note that this command is the letter "O", not the number "0".  Limits
  320. UD to the current directory only, or the alternate beginning
  321. path\directory if one is specified.  No subdirectories are processed.
  322.  
  323. -----------------------------------------------------------------------
  324.  
  325. SAVE OUTPUT FILE:
  326.  
  327.    Format:   /S
  328.    Default:  by default, the temporary file is deleted
  329.    Example:  /S
  330.  
  331. This option, which has no argument, causes UD to not delete the
  332. temporary file (UPDTDESC.BTM) upon completion.
  333.  
  334.  
  335. -----------------------------------------------------------------------
  336.  
  337. EXCLUDE FILES THAT HAVE ALREADY BEEN DESCRIBED
  338.  
  339.    Format:   /X
  340.      
  341. This causes files which already have a description in the DESCRIPT.ION
  342. file to be excluded.
  343.  
  344. Warning:  The use of this option with a 4DOS version up to and          
  345. including 3.01A, may cause this option to appear to not work
  346. correctly.  The problem exists because 4DOS will read a DESCRIPT.ION
  347. file which seperates the entries with a LF, CR, or LF/CR character
  348. combination.  It will, however, in certain circumstances, write the
  349. file with only the LF character between the entries.  UD expects the
  350. entries to have a CR character between entries, and will not read the
  351. file properly.  This problem also exists for the 4EDIT utility program.
  352. J. P. Software representatives have stated that the next version of 
  353. 4DOS will have this problem corrected. 
  354.  
  355. You are advised to not try the /X option unless you are using a version
  356. of 4DOS later than 3.01A.
  357.  
  358. Also note that once you upgrade to a later version of 4DOS, your 
  359. DESCRIPT.ION files may still contain only the LF character in some
  360. cases.  If /X allows some files to be included even though they 
  361. already have descriptions, the problem will eventually correct itself
  362. as you edit the descriptions and 4DOS uses the LF/CR as the separator
  363. between the entries.  You could edit the files with a text editor that
  364. allows you end each line with a CR/LF.
  365.  
  366. -----------------------------------------------------------------------
  367.  
  368. DELETE DESCRIPT.ION FILES
  369.  
  370.    Format:   /Z
  371.  
  372. This option allows you to delete all DESCRIPT.ION files beginning in
  373. the current path or the path you specify on the command line.  You 
  374. will be prompted to confirm each deletion.  This option does not scan
  375. each filename in the directory so most other options are invalid when
  376. you use /Z.  You may, however, enter a starting path.
  377.  
  378. -----------------------------------------------------------------------
  379.  
  380. DELETE DESCRIPT.ION FILES - WITHOUT CONFIRMATION
  381.  
  382.    Format:   /ZNOCONFIRM
  383.  
  384. This is the same as the /Z option above, but you are NOT given a chance
  385. to confirm the deletions.
  386.  
  387. -----------------------------------------------------------------------
  388.  
  389.  
  390.                                Support    
  391.  
  392. Support for UD will be available on the Software Designer BBS in 
  393. Albany, GA.  The number is (912) 432-2440.  Leave a private message to
  394. Earl Davidson, and I'll respond as soon as I can.  
  395.  
  396. This BBS may be reached via Fido-Net (1:3617/1) and RBBS-Net (8:928/1).
  397. I monitor the 4DOS echo on a regular basis.
  398.  
  399.                             
  400.  
  401.                             Release History
  402.                              
  403. Version 1.23, August 5, 1990
  404.    -  Files with descriptions beginning with "TRASH" that are already
  405.       in a "\TRASH" directly will be skipped when the /K or 
  406.       /KNOCONFIRM options are used.
  407.  
  408. Version 1.22, July 14, 1990.
  409.    -  Fixed problem which locked system.
  410.  
  411. Version 1.20, July 14, 1990.
  412.    -  Added the capability of moving files to a trash directory if the
  413.       description begins with "TRASH" and the /K option is used.
  414.  
  415.    -  Added option /O to limit the processing to only the current 
  416.       directory or the alternate beginning directory if one was 
  417.       specified.
  418.  
  419.    -  If a monochrome monitor is detected, the display will be adjusted
  420.       without the use of the /B option.
  421.  
  422. Version 1.10, July 8, 1990.
  423.    -  Added the /K and /KNOCONFIRM options to allow deletion of files
  424.       with a description of "KILL".
  425.  
  426.    -  Added documentation for the /Z and /ZNOCONFORM options which was
  427.       omitted in error.
  428.  
  429.    -  Fixed problem of failure to exclude files which have no extension
  430.       in their filename when using the /X option as well as from the
  431.       listfile. 
  432.  
  433.    -  Minor change to confirmation routine for /Z option.
  434.  
  435.    -  Additional information on /X option problem added to the
  436.       documentation file.
  437.  
  438. Version 1.00, July 4, 1990.  First release.
  439.                               
  440.  
  441.                               
  442.                             
  443.                               
  444.                               
  445.                               
  446.    
  447.  
  448.  
  449.  
  450.  
  451.  
  452.  
  453.  
  454.  
  455.  
  456.  
  457.  
  458.  
  459.  
  460.  
  461.  
  462.  
  463.  
  464.  
  465.  
  466.                            
  467.                               Registration
  468.  
  469. To register this program for permanent use, complete the form below and 
  470. mail, together with your check for $5.00, to the address on the form:
  471.                           
  472.                           
  473.                           
  474.                           
  475.                           
  476.                           
  477.                           
  478.                           UD Registration Form
  479.  
  480. Your Name: _______________________________             Date: __________
  481.  
  482. Company:   _______________________________                      
  483.                                               To:  Earl Davidson
  484. Address:   _______________________________         1505 7th Avenue
  485.                                                    Albany, GA 31707
  486.            _______________________________
  487.  
  488. City, St:  _______________________________  Zip: ___________
  489.  
  490.  
  491.  
  492. UD version number: _______________________
  493.  
  494. Where did you find your copy of UD? ___________________________________
  495.  
  496. _______________________________________________________________________
  497.  
  498. Suggestions: __________________________________________________________
  499.  
  500. _______________________________________________________________________
  501.  
  502.  
  503.